package com.eedi.framework.social.service;

import com.eedi.framework.common.enums.UserTypeEnum;
import com.eedi.framework.common.exception.ServiceException;
import com.eedi.framework.common.pojo.PageResult;
import com.eedi.framework.social.controller.sys.vo.user.SysSocialUserPageReq;
import com.eedi.framework.social.dal.dataobject.SysSocialUserDO;
import com.eedi.framework.social.enmus.SysSocialTypeEnum;
import com.eedi.framework.social.controller.sys.vo.SysSocialUserBindReq;
import com.eedi.framework.social.controller.sys.vo.SysSocialUserResp;

import javax.validation.Valid;
import java.util.List;

/**
 * 社交用户 Service 接口，例如说社交平台的授权登录
 *
 * @author 永聚长青源码
 */
public interface SysSocialUserService {

    /**
     * 获得指定用户的社交用户列表
     *
     * @param userId   用户编号
     * @param userType 用户类型
     * @return 社交用户列表
     */
    List<SysSocialUserDO> getSocialUserList(String userId, UserTypeEnum userType);

    /**
     * 绑定社交用户
     *
     * @param reqDTO 绑定信息
     * @return 社交用户 openid
     */
    String bindSocialUser(@Valid SysSocialUserBindReq reqDTO);

    /**
     * 取消绑定社交用户
     *
     * @param userId 用户编号
     * @param userType 全局用户类型
     * @param socialType 社交平台的类型 {@link SysSocialTypeEnum}
     * @param openid 社交平台的 openid
     */
    void unbindSocialUser(String userId, UserTypeEnum userType, SysSocialTypeEnum socialType, String openid);

    /**
     * 获得社交用户
     *
     * 在认证信息不正确的情况下，也会抛出 {@link ServiceException} 业务异常
     *
     * @param userType 用户类型
     * @param socialType 社交平台的类型
     * @param code 授权码
     * @param state state
     * @return 社交用户
     */
    SysSocialUserResp getSocialUser(UserTypeEnum userType, SysSocialTypeEnum socialType, String code, String state);

    // ==================== 社交用户 CRUD ====================

    /**
     * 获得社交用户
     *
     * @param socialUserId 编号
     * @return 社交用户
     */
    SysSocialUserDO getSocialUser(String socialUserId);

    /**
     * 获得社交用户分页
     *
     * @param pageReqVO 分页查询
     * @return 社交用户分页
     */
    PageResult<SysSocialUserDO> getSocialUserPage(SysSocialUserPageReq pageReqVO);

}
